<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::session::Client_app Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1session.html">session</a></li><li class="navelem"><a class="el" href="structipc_1_1session_1_1Client__app.html">Client_app</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="structipc_1_1session_1_1Client__app-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::session::Client_app Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>An <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> that is used as a client in at least one client-server IPC split.  
 <a href="structipc_1_1session_1_1Client__app.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="app_8hpp_source.html">app.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ipc::session::Client_app:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="structipc_1_1session_1_1Client__app__inherit__graph.svg" width="164" height="107"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ipc::session::Client_app:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="structipc_1_1session_1_1Client__app__coll__graph.svg" width="382" height="278"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9d1ec69e821e034305e20cfbf1161a04"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Client__app.html#a9d1ec69e821e034305e20cfbf1161a04">Base</a> = <a class="el" href="structipc_1_1session_1_1App.html">App</a></td></tr>
<tr class="memdesc:a9d1ec69e821e034305e20cfbf1161a04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for base type.  <a href="structipc_1_1session_1_1Client__app.html#a9d1ec69e821e034305e20cfbf1161a04">More...</a><br /></td></tr>
<tr class="separator:a9d1ec69e821e034305e20cfbf1161a04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add718cbf6aa1d2abb26fbadcc974a7bd"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Client__app.html#add718cbf6aa1d2abb26fbadcc974a7bd">Master_set</a> = boost::unordered_map&lt; std::string, <a class="el" href="structipc_1_1session_1_1Client__app.html">Client_app</a> &gt;</td></tr>
<tr class="memdesc:add718cbf6aa1d2abb26fbadcc974a7bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suggested type for storing master repository or all <code>Client_apps</code>s. See <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> doc header for discussion.  <a href="structipc_1_1session_1_1Client__app.html#add718cbf6aa1d2abb26fbadcc974a7bd">More...</a><br /></td></tr>
<tr class="separator:add718cbf6aa1d2abb26fbadcc974a7bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_structipc_1_1session_1_1App"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structipc_1_1session_1_1App')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structipc_1_1session_1_1App.html">ipc::session::App</a></td></tr>
<tr class="memitem:af7527bc1ad0cde62cd4fde97bc1d7ecc inherit pub_types_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#af7527bc1ad0cde62cd4fde97bc1d7ecc">Master_set</a> = boost::unordered_map&lt; std::string, <a class="el" href="structipc_1_1session_1_1App.html">App</a> &gt;</td></tr>
<tr class="memdesc:af7527bc1ad0cde62cd4fde97bc1d7ecc inherit pub_types_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suggested type for storing master repository or all <code>Apps</code>s. See <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> doc header for discussion.  <a href="structipc_1_1session_1_1App.html#af7527bc1ad0cde62cd4fde97bc1d7ecc">More...</a><br /></td></tr>
<tr class="separator:af7527bc1ad0cde62cd4fde97bc1d7ecc inherit pub_types_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="related" name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p >(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a0e786447d51449f1249c10e127ab10e2"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Client__app.html#a0e786447d51449f1249c10e127ab10e2">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="structipc_1_1session_1_1Client__app.html">Client_app</a> &amp;val)</td></tr>
<tr class="memdesc:a0e786447d51449f1249c10e127ab10e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints string representation of the given <code>Client_appp</code> to the given <code>ostream</code>.  <a href="structipc_1_1session_1_1Client__app.html#a0e786447d51449f1249c10e127ab10e2">More...</a><br /></td></tr>
<tr class="separator:a0e786447d51449f1249c10e127ab10e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header related_structipc_1_1session_1_1App"><td colspan="2" onclick="javascript:toggleInherit('related_structipc_1_1session_1_1App')"><img src="closed.png" alt="-"/>&#160;Related Functions inherited from <a class="el" href="structipc_1_1session_1_1App.html">ipc::session::App</a></td></tr>
<tr class="memitem:a6b2f9a90ac9cc5098d9b90e7f547c97e inherit related_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="structipc_1_1session_1_1App.html">App</a> &amp;val)</td></tr>
<tr class="memdesc:a6b2f9a90ac9cc5098d9b90e7f547c97e inherit related_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints string representation of the given <code><a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a></code> to the given <code>ostream</code>.  <a href="structipc_1_1session_1_1App.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">More...</a><br /></td></tr>
<tr class="separator:a6b2f9a90ac9cc5098d9b90e7f547c97e inherit related_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_structipc_1_1session_1_1App"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structipc_1_1session_1_1App')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structipc_1_1session_1_1App.html">ipc::session::App</a></td></tr>
<tr class="memitem:a8e67b57829fe43a122a23c699b5de8fd inherit pub_attribs_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd">m_name</a></td></tr>
<tr class="memdesc:a8e67b57829fe43a122a23c699b5de8fd inherit pub_attribs_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">Brief application name, readable to humans and unique across all other applications' names; used both as a short programmatic key in shared resource naming (including as a folder in <a class="el" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea" title="Convenience alias for the commonly used type util::Shared_name.">Shared_name</a> for kernel-persistent resources and addresses; and in path names &ndash; such as PID file name &ndash; in the file system).  <a href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd">More...</a><br /></td></tr>
<tr class="separator:a8e67b57829fe43a122a23c699b5de8fd inherit pub_attribs_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae82a8635858664720c8546e468f8090b inherit pub_attribs_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top">fs::path&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#ae82a8635858664720c8546e468f8090b">m_exec_path</a></td></tr>
<tr class="memdesc:ae82a8635858664720c8546e468f8090b inherit pub_attribs_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">Absolute, lexically normalized canonical path to the executable entity (which is not a directory), as it would appear in a command line or <code>exec()</code>-like invocation when actually invoking the application.  <a href="structipc_1_1session_1_1App.html#ae82a8635858664720c8546e468f8090b">More...</a><br /></td></tr>
<tr class="separator:ae82a8635858664720c8546e468f8090b inherit pub_attribs_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e32297579603f2d96616976474d0246 inherit pub_attribs_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceipc_1_1util.html#a6435c1b48ec8684c24ca406d1d17208e">util::user_id_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#a9e32297579603f2d96616976474d0246">m_user_id</a></td></tr>
<tr class="memdesc:a9e32297579603f2d96616976474d0246 inherit pub_attribs_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">The application must run as this user ID (UID). Files and other shared resources shall have this owner.  <a href="structipc_1_1session_1_1App.html#a9e32297579603f2d96616976474d0246">More...</a><br /></td></tr>
<tr class="separator:a9e32297579603f2d96616976474d0246 inherit pub_attribs_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78bb1e984835f429fd44869a83f4b093 inherit pub_attribs_structipc_1_1session_1_1App"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceipc_1_1util.html#a3f7d069ce0d23f73153da2e2559dc3d3">util::group_id_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1App.html#a78bb1e984835f429fd44869a83f4b093">m_group_id</a></td></tr>
<tr class="memdesc:a78bb1e984835f429fd44869a83f4b093 inherit pub_attribs_structipc_1_1session_1_1App"><td class="mdescLeft">&#160;</td><td class="mdescRight">The application must run as this group ID (GID). Files and other shared resources shall have this owner.  <a href="structipc_1_1session_1_1App.html#a78bb1e984835f429fd44869a83f4b093">More...</a><br /></td></tr>
<tr class="separator:a78bb1e984835f429fd44869a83f4b093 inherit pub_attribs_structipc_1_1session_1_1App"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >An <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> that is used as a client in at least one client-server IPC split. </p>
<p >This is explained in the "App, Client_app, Server_app registry conventions" section of the <code>struct</code> <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> doc header.</p>
<dl class="section see"><dt>See also</dt><dd><code>struct</code> <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> doc header.</dd></dl>
<p>As of this writing a <a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a> is just an <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> with no added stored information. That said a <a class="el" href="structipc_1_1session_1_1Server__app.html" title="An App that is used as a server in at least one client-server IPC split.">Server_app</a> may exist whose <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> base object is equals to a <a class="el" href="structipc_1_1session_1_1Client__app.html" title="An App that is used as a client in at least one client-server IPC split.">Client_app</a> <code>*this</code>'s <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> base object (in particular <a class="el" href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd" title="Brief application name, readable to humans and unique across all other applications&#39; names; used both...">App::m_name</a> but also all other members). </p>

<p class="definition">Definition at line <a class="el" href="app_8hpp_source.html#l00184">184</a> of file <a class="el" href="app_8hpp_source.html">app.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a9d1ec69e821e034305e20cfbf1161a04" name="a9d1ec69e821e034305e20cfbf1161a04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d1ec69e821e034305e20cfbf1161a04">&#9670;&nbsp;</a></span>Base</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="structipc_1_1session_1_1Client__app.html#a9d1ec69e821e034305e20cfbf1161a04">ipc::session::Client_app::Base</a> =  <a class="el" href="structipc_1_1session_1_1App.html">App</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Short-hand for base type. </p>

<p class="definition">Definition at line <a class="el" href="app_8hpp_source.html#l00189">189</a> of file <a class="el" href="app_8hpp_source.html">app.hpp</a>.</p>

</div>
</div>
<a id="add718cbf6aa1d2abb26fbadcc974a7bd" name="add718cbf6aa1d2abb26fbadcc974a7bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add718cbf6aa1d2abb26fbadcc974a7bd">&#9670;&nbsp;</a></span>Master_set</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="structipc_1_1session_1_1Client__app.html#add718cbf6aa1d2abb26fbadcc974a7bd">ipc::session::Client_app::Master_set</a> =  boost::unordered_map&lt;std::string, <a class="el" href="structipc_1_1session_1_1Client__app.html">Client_app</a>&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Suggested type for storing master repository or all <code>Client_apps</code>s. See <a class="el" href="structipc_1_1session_1_1App.html" title="A description of an application in this ipc::session inter-process communication universe.">App</a> doc header for discussion. </p>

<p class="definition">Definition at line <a class="el" href="app_8hpp_source.html#l00192">192</a> of file <a class="el" href="app_8hpp_source.html">app.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a0e786447d51449f1249c10e127ab10e2" name="a0e786447d51449f1249c10e127ab10e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e786447d51449f1249c10e127ab10e2">&#9670;&nbsp;</a></span>operator&lt;&lt;()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream &amp; operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structipc_1_1session_1_1Client__app.html">Client_app</a> &amp;&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Prints string representation of the given <code>Client_appp</code> to the given <code>ostream</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>Stream to which to write. </td></tr>
    <tr><td class="paramname">val</td><td>Object to serialize. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>os</code>. </dd></dl>

<p class="definition">Definition at line <a class="el" href="app_8cpp_source.html#l00129">129</a> of file <a class="el" href="app_8cpp_source.html">app.cpp</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>session/<a class="el" href="app_8hpp_source.html">app.hpp</a></li>
<li>session/<a class="el" href="session__fwd_8hpp_source.html">session_fwd.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:39 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
